From: Matthias Clasen <mclasen@redhat.com>
Date: Tue, 11 Oct 2022 18:03:57 +0000 (-0400)
Subject: stringsorter: Add more detail to the docs
X-Git-Tag: archive/raspbian/4.12.3+ds-1+rpi1~1^2^2^2~116^2~1^2~185^2~1
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=05323869d72e466faa286881c959c1de58cfe22b;p=gtk4.git

stringsorter: Add more detail to the docs

Mention when a collation value of NONE might
be useful.
---

diff --git a/gtk/gtkstringsorter.c b/gtk/gtkstringsorter.c
index 266fc81e55..507adca17c 100644
--- a/gtk/gtkstringsorter.c
+++ b/gtk/gtkstringsorter.c
@@ -335,6 +335,12 @@ gtk_string_sorter_class_init (GtkStringSorterClass *class)
    *
    * The collation method to use for sorting.
    *
+   * The `GTK_COLLATION_NONE` value is useful when the expression already
+   * returns collation keys, or strings that need to be compared byte-by-byte.
+   *
+   * The default value, `GTK_COLLATION_UNICODE`, compares strings according
+   * to the [Unicode collation algorithm](https://www.unicode.org/reports/tr10/).
+   *
    * Since: 4.10
    */
   properties[PROP_COLLATION] =